home *** CD-ROM | disk | FTP | other *** search
/ Suzy B Software 2 / Suzy B Software CD-ROM 2 (1994).iso / extras / programm / mcode_01 / docs / escape.txt < prev    next >
Text File  |  1995-04-27  |  4KB  |  112 lines
  1. File Description     : List of escape sequences
  2. Author             : Stephen McNabb
  3. Creation Date        : 15th February 1995
  4. Last Updated        : 15th Februray 1995
  5.  
  6.     This is a list of the availble escape sequences that can be
  7. accessed using Cconout(). To use these sequences you must first
  8. output and escape character using Cconout() and then the appropriate
  9. characters.
  10.  
  11. Example
  12.  
  13. To clear the screen the following code would be used:
  14.  
  15.     move.w    #27,-(sp)    /escape character
  16.     move.w    #$2,-(sp)    /use Cconout() function
  17.     trap    #1        /use gemdos
  18.     addq.l    #4,sp        /tidy up stack
  19.     
  20.     move.w    #'E',-(sp)    /use Clear screen sequences
  21.     move.w    #$2,-(sp)    /use Cconout() function
  22.     trap    #1        /use gemdos
  23.     addq.l    #4,sp        /tidy up stack
  24.     
  25.     
  26. Character    Action
  27. ---------    ------
  28.     A        Moves cursor up one line. If already at the top of
  29.             the screen then it has no effect.
  30.  
  31.     B        Moves cursor down one line. If already at the bottom
  32.             of the screen then it has no effect.
  33.  
  34.     C        Moves cursor one character to the right. If already
  35.             at the right hand side of the screen then it has no effect.
  36.  
  37.     D        Moves cursor one character to the left. If already
  38.             at the left hand side of the screen then it has no effect.
  39.  
  40.     E        Clears the screen and places the cursor at the top-left
  41.             hand corner of the screen.
  42.  
  43.     H        Places cursor at the top-left hand corner of the screen
  44.             without clearing the screen.
  45.  
  46.     I        Moves cursor up one line. If at the top of the screen
  47.             then all other lines are scrolled down one line.
  48.  
  49.     J        Erases all text from current cursor position
  50.             to the end of the screen.
  51.  
  52.     K        Erases all text from current cursor position
  53.             to the end of the current line.
  54.  
  55.     L        Inserts a new line, by scrolling all lines, below and
  56.             including the current line the cursor is on, down one line.
  57.             The cursor is positioned at the start of the new blank line.
  58.  
  59.     M        Deletes the current line the cursor is on, scrolls all lines
  60.             below it up one and inserts a blank line at the bottom. The
  61.             cursor is positioned at the start of the current line.
  62.             
  63.     Y        Positions cursor on screen. The following two values from
  64.             Cconout() specify the row and column of the cursor. Values
  65.             are single byte binary numbers and begin at 1.
  66.     
  67.     b        Sets the foreground colour index of the text to be displayed.
  68.             The following value from Cconout() specifies the colour index
  69.             to be used. The four least significant bits of the value are
  70.             used.
  71.             
  72.     c        Sets the background colour index of the text to be displayed.
  73.             The following value from Cconout() specifies the colour index
  74.             to be used. The four least significant bits of the value are
  75.             used.
  76.             
  77.     d        Erases all text from the screen from the beginning of the
  78.             screen to the current cursor position.
  79.             
  80.     e        Makes the cursor visible, usually after using ESC 'f'.
  81.     
  82.     f        Makes the cursor invisible. It can still be moved about the
  83.             screen.
  84.             
  85.     j        Saves the current cursor position. To be used with
  86.             ESC 'k'.
  87.             
  88.     k        Restores the cursor position that was saved using ESC 'j'.
  89.             If the cursor position has not been saved then the cursor
  90.             is placed at the top-left hand corner of the screen.
  91.             
  92.     l        Erases the current line that the cursor is on. The lines
  93.             below it are not scrolled up. The cursor is positioned
  94.             at the start of the line.
  95.             
  96.     o        Erase all the text from the start of the current line
  97.             to the current cursor position on that line.
  98.             
  99.     p        Enables reverse video text. The background and foreground
  100.             colours are swapped.
  101.             
  102.     q        Disables reverse video text.
  103.     
  104.     v        Switches text wrap on. Characters written past the end of the
  105.             line is displayed on the next line.
  106.             
  107.     w        Switches text wrap off. Characters written past the end of the
  108.             line are written over each other at the right hand side of
  109.             the screen.
  110.             
  111. *** End of File ***
  112.